home *** CD-ROM | disk | FTP | other *** search
/ BBS in a Box 12 / BBS in a box XII-1.iso / Files / System7 tools / Frontier / ARA Server.sit / ARA Server / DocServer Source Text < prev    next >
Encoding:
Text File  |  1992-03-13  |  4.8 KB  |  100 lines  |  [TEXT/ttxt]
  1.  
  2. Verb    ARA.connect
  3. Syntax    ARA.connect (documentPath, password, showProgress)
  4. Parameters    documentPath is a file system path to an ARA session document, created by Apple’s Remote Access application, that contains the user name and phone number to be used for the connection.
  5. password is the user password. It can be the empty string if the password is saved in the session document, or if a prompt is desired.  See Notes.
  6. showProgress is a boolean value, indicating whether or not the modal progress dialog should be displayed as the connection is established.
  7. Action    Establishes a remote connection using the connection document at documentPath.
  8. Returns    True if a connection is successfully established, otherwise false.
  9. Examples    ARA.connect ("Work:Utilities:ARA Login", "", true)
  10.     « true
  11. Notes    If password is the  empty string, and the user password is not saved in the ARA session document, this verb will display a dialog requesting that a password be entered.
  12. If showProgress is false, the connection will be established asynchonously.  To determine whether or not the connection has been completed, use ARA.connectionStatus
  13. See Also    ARA.connectionStatus
  14. ARA.disconnect
  15.  
  16. Verb    ARA.connectedTo
  17. Syntax    ARA.connectedTo ()
  18. Parameters    None.
  19. Action    Retrieves the name of the host machine for the current session.
  20. Returns    The name of the current host machine, or the empty string if not connected.
  21. Examples    ARA.connectedTo ()
  22.     « Susan's Mac IIsi
  23.  
  24. Verb    ARA.connectionStatus
  25. Syntax    ARA.connectionStatus ()
  26. Parameters    None.
  27. Action    Determines whether a connection is in progress, or is being established, canceled, or broken.
  28. Returns    3 if connected, 2 if in the process of connecting, 1 if canceling a new connection, 0 if not connected, and -1 if in the process of disconnecting.
  29. Examples    return (ARA.connectionStatus () >= 2) «see if we’re connected or in the process of connecting
  30.     « true
  31. Notes    Unless ARA.connect or ARA.disconnect is called asynchronously — with showDialog false — this verb will always return either 0 or 3.
  32. See Also    ARA.statusMessage
  33.  
  34. Verb    ARA.disconnect
  35. Syntax    ARA.disconnect (showProgress)
  36. Parameters    showProgress is a boolean value, indicating whether or not the modal progress dialog should be displayed as the connection is broken.
  37. Action    Terminates the current connection.
  38. Returns    True if the connection is successfully broken, otherwise false.
  39. Examples    ARA.disconnect (false)
  40.     « true
  41. Notes    If showProgress is false, the connection will be broken asynchonously.  To determine whether or not the disconnection has completed, use ARA.connectionStatus
  42. See Also    ARA.connect
  43. ARA.connectionStatus
  44.  
  45. Verb    ARA.inAnswerMode
  46. Syntax    ARA.inAnswerMode ()
  47. Parameters    None.
  48. Action    Determines whether or not Remote Access is waiting for incoming calls.
  49. Returns    True if ARA is set up to receive incoming calls, false otherwise.
  50. Examples    ARA.inAnswerMode ()
  51.     « false
  52. Notes    The verb is not completely implemented, and currently always returns false.
  53.  
  54. Verb    ARA.setMessage
  55. Syntax    ARA.setMessage (messageString)
  56. Parameters    messageString is a single line of text to be displayed in the ARA message window.
  57. Action    Displays the text in messageString in the ARA message window.
  58. Returns    True.
  59. Examples    ARA.setMessage (ARA.statusMessage ())
  60.     « true
  61. See Also    ARA.statusMessage
  62.  
  63. Verb    ARA.statusMessage
  64. Syntax    ARA.statusMessage ()
  65. Parameters    None.
  66. Action    Retrieves the Remote Access Manager's internal status message.
  67. Returns    The current ARA status message, or the empty string if not connected.
  68. Examples    ARA.statusMessage ()
  69.     « Communicating at 2400 bps.
  70. See Also    ARA.connectionStatus
  71.  
  72. Verb    ARA.timeConnected
  73. Syntax    ARA.timeConnected ()
  74. Parameters    None.
  75. Action    Determines how long the current session has been in progress.
  76. Returns    The number of seconds that the current connection has been established, or zero in not connected.
  77. Examples    return ("Connected for " + ARA.timeConnected () / 60 + " minutes.")
  78.     « Connected for 7 minutes.
  79. See Also    ARA.timeRemaining
  80.  
  81. Verb    ARA.timeRemaining
  82. Syntax    ARA.timeRemaining ()
  83. Parameters    None.
  84. Action    Determines how much time is remaining in the current session.
  85. Returns    The number of seconds remaining in the current connection,  or zero in not connected.  If no time limit has been established, returns -1.
  86. Examples    return ("There are " + ARA.timeRemaining () / 60 + " minutes remaining for this session.")
  87.     « There are 27 minutes remaining for this session.
  88. Notes    The time limit is established by the host machine, in the Remote Access Setup control panel.
  89. See Also    ARA.timeConnected
  90.  
  91. Verb    ARA.userName
  92. Syntax    ARA.userName ()
  93. Parameters    None.
  94. Action    Retrieves the user name that was used to establish the current connection.
  95. Returns    The current user name, or the empty string if not connected.
  96. Examples    ARA.userName ()
  97.     « mitch
  98. Notes    The user name is specified in the Remote Access session document used to established the connection.
  99. See Also    ARA.connect
  100.